Environment Setup
You can choose to skip the advanced environment configuration and setup and accept default values by entering Y
on the first question Quick Setup without advanced configuration? (Y for yes, N for No)
.
If you chose Y
, you can skip the remainder of this section.
If you choose N
on skipping environment setup, you will be prompted to enter some settings unless you already have your .env
file set up. If you do not have your .env
file set up, you can use the following as a guide:
If you choose
Y
to automatically update when AGiXT is launched, you will have the latest version.AGIXT_API_KEY
is the API key to use for the AGiXT API. This is empty by default, if you would like to set it, change it in the env file. The header format for requests will beAuthorization: Bearer {your_api_key}
for any requests to your AGiXT server or you can pass theapi_key
to the AGiXT SDK. This feature makes your instances more secure.If you want to have your own
fork
for different services (i.e., prompts or chains) that you want to load every time, you need to set it up and answerY
for owningAGiXT Hub fork
.AGIXT_URI
is the URI of the AGiXT instance, this should behttp://agixt:7437
by default. If hosting the AGiXT server separately, change this to the URI of your AGiXT server, otherwise leave it as-is.UVICORN_WORKERS
is the number of workers to run the web server with, this is10
by default, adjust this to your system's capabilities.It also asks different questions related to
run local models
,use Oobabooga text generation web UI
(if you have NVIDIA),GPU compute capability
,text generation web UI startup parameters
, and run database touse postgres
to prepare a more suitable environment for the user.
Database configuration only applicable if using database
DB_CONNECTED
is whether or not you want to use a database, this should befalse
by default, change this totrue
if you want to use a database. If you choose to, you will need to edit the database configuration options below, otherwise they can be left alone.POSTGRES_DB
is the name of the database, this should bepostgres
by default.POSTGRES_PORT
is the port that the database is listening on, this should be5432
by default.POSTGRES_SERVER
is the address to host the database,localhost
is the default.POSTGRES_USER
is the username to connect to the database with, this should bepostgres
by default.POSTGRES_PASSWORD
is the password to connect to the database with, this should be changed from the example file if using database.
Oobabooga Text Generation Web UI Configuration
TORCH_CUDA_ARCH_LIST
is the CUDA architecture list to use for the Oobabooga text generation web UI. Example: RTX3000-5000 series are version7.5
. Find yours at https://developer.nvidia.com/cuda-gpus .CLI_ARGS
is the CLI arguments to pass to the Oobabooga text generation web UI. By default, this is set to--listen --api --chat
and is not configurable in the AGiXT installer, it will need changes manually in the.env
file if you want to change it to add additional arguments.
Additional Environment Variables
There are additional environment variables that can be set in the .env
file, but are not required or defined in the installer script. These are listed below:
DISABLED_PROVIDERS
- A comma-separated list of providers to disable. This is empty by default. The example below would disable the Petal, Palm, and Pipeline providers.DISABLED_PROVIDERS=petal,palm,pipeline
DISABLED_EXTENSIONS
- A comma-separated list of extensions to disable. This is empty by default. The example below would disable the file system, Twitter, and Searxng extensions.DISABLED_EXTENSIONS=file_system,twitter,searxng
NGROK_TOKEN
is the ngrok token to use for the ngrok tunnel, this is empty by default, if you would like to use ngrok, change this to your ngrok token.